<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - greg.ross.ColourGradient</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/greg.ross.ColourGradient.html">greg.ross.ColourGradient</a></li>
	
	<li><a href="../symbols/greg.ross.DefaultCellRenderer.html">greg.ross.DefaultCellRenderer</a></li>
	
	<li><a href="../symbols/greg.ross.Fisheye.html">greg.ross.Fisheye</a></li>
	
	<li><a href="../symbols/greg.ross.FisheyeCellRenderer.html">greg.ross.FisheyeCellRenderer</a></li>
	
	<li><a href="../symbols/greg.ross.FisheyeTable.html">greg.ross.FisheyeTable</a></li>
	
	<li><a href="../symbols/greg.ross.Hashtable.html">greg.ross.Hashtable</a></li>
	
	<li><a href="../symbols/greg.ross.MagicTable.html">greg.ross.MagicTable</a></li>
	
	<li><a href="../symbols/greg.ross.Matrix.html">greg.ross.Matrix</a></li>
	
	<li><a href="../symbols/greg.ross.ScaleCellRenderer.html">greg.ross.ScaleCellRenderer</a></li>
	
	<li><a href="../symbols/greg.ross.TableGeometry.html">greg.ross.TableGeometry</a></li>
	
	<li><a href="../symbols/greg.ross.TableGradientColourProvider.html">greg.ross.TableGradientColourProvider</a></li>
	
	<li><a href="../symbols/greg.ross.TableMath.html">greg.ross.TableMath</a></li>
	
	<li><a href="../symbols/greg.ross.TableModel.html">greg.ross.TableModel</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class greg.ross.ColourGradient
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_Users_gregross_magic-table_magic-table_javascript_ColourGradient.js.html">ColourGradient.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class greg.ross.ColourGradient.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/greg.ross.ColourGradient.html#constructor">greg.ross.ColourGradient</a></b>(minValue, maxValue, rgbColourArray)
							</div>
							<div class="description">Class that is used to define a path through RGB space.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class greg.ross.ColourGradient.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/greg.ross.ColourGradient.html#getColour">getColour</a></b>(value)
								</div>
								<div class="description">Return a colour from a position on the path in RGB space that is proportioal to
the number specified in relation to the minimum and maximum values from which the
bounds of the path are derived.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>greg.ross.ColourGradient</b>(minValue, maxValue, rgbColourArray)
				</div>
				
				<div class="description">
					Class that is used to define a path through RGB space.
					<br /><i>Author: </i>Greg Ross.
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								 <b>minValue</b>
								
							</dt>
								<dd>the value that will return the first colour on the path in RGB space</dd>
						
							<dt>
								 <b>maxValue</b>
								
							</dt>
								<dd>the value that will return the last colour on the path in RGB space</dd>
						
							<dt>
								 <b>rgbColourArray</b>
								
							</dt>
								<dd>the set of colours that defines the dirctional path through RGB space.
The length of the array must be greater than two.</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="getColour"> </a>
					<div class="fixedFont">
					
					
					<b>getColour</b>(value)
					
					</div>
					<div class="description">
						Return a colour from a position on the path in RGB space that is proportioal to
the number specified in relation to the minimum and maximum values from which the
bounds of the path are derived.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>value</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
			<hr />
		</div>
		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.2 on Sun Aug 24 2008 18:56:50 GMT+0100 (BST)
		</div>
	</body>
</html>
